// BandsInTown Java API Client - BandsInTown service interface
// Copyright 2009 PriceFeeder Inc.  All rights reserved.
// http://code.google.com/p/bandsintown-java/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of PriceFeeder Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.pricefeeder.bandsintown;

import com.pricefeeder.bandsintown.model.ErrorResponse;

/**
 * Encapsulates an exception that occurs during the actual BandsInTown service
 * call. Represents internal service errors from BandsInTown such as 500
 * Internal Server Error
 * 
 * @author Eli Colner
 * 
 */

// Immutable
public class ServiceException extends Exception {

	/**
	 * generated service id
	 */
	private static final long serialVersionUID = 4240995217189012761L;
	
	/**
	 * any error that is received as a result of your service call
	 */
	private ErrorResponse errorResponse;

	/**
	 * Instantiate with a message.
	 * @param message
	 *            the error message
	 */
	public ServiceException(String message) {
		super(message);
	}

	/**
	 * Instantiate with an ErrorResponse.
	 * @param errorResponse
	 *            the error
	 */
	public ServiceException(ErrorResponse errorResponse) {
		this.errorResponse = errorResponse;
	}
	
	/**
	 * If your service call resulted in an error on the BandsInTown side, then
	 * you can examine the actual error using this return value.
	 * 
	 * @return null or the ErrorResponse from your service call.
	 */
	public ErrorResponse getErrorResponse() {
		return errorResponse;
	}
	
}
